home *** CD-ROM | disk | FTP | other *** search
/ Info-Mac 3 / Info_Mac_1994-01.iso / Development / General / SITcomm AppleScript Guide < prev    next >
Encoding:
Text File  |  1993-12-06  |  25.8 KB  |  763 lines  |  [TEXT/ttxt]
  1. Verb    SITcomm.appendSelection
  2. Syntax    SITcomm.appendSelection(f)
  3. Parameters    f is the path to the file you wish to append to.  
  4. The file will be created if it does not already exist.
  5. Action    Appends current text selection to the specified file.
  6. Returns    0 if no errors
  7. -1 if no current selection
  8. a File Mgr error code.
  9. Example    with SITcomm
  10.     appendSelection("HD:myFile")
  11. See also    SITcomm.printSelection
  12. SITcomm.saveSelection
  13.  
  14. Verb    SITcomm.bringToFront
  15. Syntax    SITcomm.bringToFront()
  16. Parameters    none
  17. Action    makes SITcomm the frontmost, active application
  18. Returns    true if SITcomm is running
  19. Example    with SITcomm
  20.     bringToFront()
  21. See also    sys.bringAppToFront
  22.  
  23. Verb    SITcomm.clearBuffer
  24. Syntax    SITcomm.clearBuffer()
  25. Parameters    none
  26. Action    Clears entire contents of the terminal window.
  27. Returns    none
  28. Example    with SITcomm
  29.     clearBuffer()
  30.  
  31. Verb    SITcomm.connect
  32. Syntax    SITcomm.connect(s)
  33. Parameters    (s) is the AddressBook entry with which you wish to connect
  34. Action    Opens a communication channel to external devices using the specified connection tool and settings.
  35. Returns    0 if SITcomm is running, and the connection is established
  36. -1 if the Address Book entry does not exist
  37. -2 if the connection is established, but waiting for a password
  38. -3 if the connection is established, but automatic login failed
  39. -4 if the connection is already open.
  40. Example    with SITcomm
  41.     connect("CIS")
  42. See also    SITcomm.disconnect
  43. SITcomm.getConnectionStatus
  44. SITcomm.listenForConnection
  45. SITcomm.openConnection
  46.  
  47. Verb    SITcomm.disconnect
  48. Syntax    SITcomm.disconnect()
  49. Parameters    none
  50. Action    Closes the communication channel to external devices.
  51. Returns    0 if no errors
  52. Example    with SITcomm
  53.     disconnect()
  54. See also    SITcomm.connect
  55. SITcomm.getConnectionStatus
  56. SITcomm.listenForConnection
  57. SITcomm.openConnection
  58.  
  59. Verb    SITcomm.expand
  60. Syntax    SITcomm.expand(file, destination, deleteoriginal) 
  61. Parameters    file  -- pathname to the source file
  62. destination --  pathname to the folder into which to expand the file
  63. deleteOriginal -- true or false 
  64. Action    Expand a list of archives (StuffIt, Compact Pro, AppleLink or BinHex4)                        
  65. Returns    0 if no error.
  66. 4 if  there is an archive integrity error,
  67. a negative number if a standard Macintosh OSError
  68. Example    with SITcomm
  69.     expand ("HD:Example.sit", "HD:Expanded Files:", true)
  70. See also    SITcomm.stuff
  71. SITcomm.translate
  72.  
  73. Verb    SITcomm.getAddressList
  74. Syntax    SITcomm.getAddressList() 
  75. Parameters    none required
  76. Action    Returns a list of all entries in the current Address Book.
  77. Returns    the list of address book entries
  78. Example    with SITcomm
  79.     getAddressList() 
  80. See Also    SITcomm.connect
  81. SITcomm.getToolConfigForAddress
  82. SITcomm.outlineAddressBook
  83.  
  84. Verb    SITcomm.getConnectionStatus
  85. Syntax    SITcomm.getConnectionStatus() 
  86. Parameters    none required
  87. Action    Returns the state of the connection - open, closed or listening.
  88. Returns    0 if the connection is closed.
  89. 1 if the connection is open.
  90. 2 if listening for a connection.
  91. Example    with SITcomm
  92.     getConnectionStatus() 
  93. See Also    SITcomm.connect
  94. SITcomm.disconnect
  95. SITcomm.listenForConnection
  96. SITcomm.openConnection
  97.  
  98. Verb    SITcomm.getConnSettings
  99. Syntax    SITcomm.getConnSettings()
  100. Parameters    none required
  101. Action    Returns the name of the current connection tool & it's settings
  102. Returns    the name of the current connection tool & it's settings (CR delimited)
  103. Example    with SITcomm
  104.     getConnSettings()
  105. See Also    SITcomm.getTermSettings
  106. SITcomm.getXferSettings
  107. SITcomm.setConnSettings
  108.  
  109. Verb    SITcomm.getCurrentAddress
  110. Syntax    SITcomm.getCurrentAddress()
  111. Parameters    none required
  112. Action    Returns the name of the current Address as displayed in the Toolbar.
  113. Returns    the the name of the current Address
  114. Example    with SITcomm
  115.     getCurrentAddress()
  116. See Also    SITcomm.connect
  117. SITcomm.loadAddres
  118.  
  119. Verb    SITcomm.getGlobalNotepadText
  120. Syntax    SITcomm.getGlobalNotepadText()
  121. Parameters    none required
  122. Action    Returns the entire contents of the global notepad.
  123. Returns    the entire contents of the global notepad.
  124. Example    with SITcomm
  125.     getGlobalNotepadText()
  126. See Also    SITcomm.setGlobalNotepadText
  127. SITcomm.getNotepadText
  128. SITcomm.setNotepadText
  129.  
  130. Verb    SITcomm.getNotepadText
  131. Syntax    SITcomm.getNotepadText()
  132. Parameters    none required
  133. Action    Returns the entire contents of the current session’s notepad.
  134. Example    with SITcomm
  135.     getNotepadText()
  136. See Also    SITcomm.getGlobalNotepadText
  137. SITcomm.setNotepadText
  138.  
  139. Verb    SITcomm.getReceiveFolder
  140. Syntax    SITcomm.getReceiveFolder()
  141. Parameters    none required
  142. Action    Returns the path to the folder where files will be received and capture files created.
  143. Returns    The path to the current receive folder
  144. Example    with SITcomm
  145.     getReceiveFolder()
  146. See Also    SITcomm.setReceiveFolder
  147. SITcomm.receiveFilesToFolder
  148. SITcomm.turnOnCapturingWithFile
  149.  
  150. Verb    SITcomm.getSelection
  151. Syntax    SITcomm.getSelection() 
  152. Parameters    none required
  153. Action    Returns the text of the current selection.
  154. Returns    Returns the text currently selected.
  155. Example    with SITcomm
  156.     getSelection() 
  157. See Also    SITcomm.appendSelection
  158. SITcomm.printSelection
  159. SITcomm.saveSelection
  160.  
  161. Verb    SITcomm.getTermSettings
  162. Syntax    SITcomm.getTermSettings()
  163. Parameters    none required
  164. Action    Returns the name of the current terminal tool & it's settings
  165. Returns    the name of the current terminal tool & it's settings (CR delimited)
  166. Example    with SITcomm
  167.     getTermSettings()
  168. See Also    SITcomm.getConnSettings
  169. SITcomm.getXferSettings
  170. SITcomm.setTermSettings
  171.  
  172. Verb    SITcomm.getTimer
  173. Syntax    SITcomm.getTimer()
  174. Parameters    none required
  175. Action    Returns the elapsed time (in seconds) since the current connection was opened.
  176. Example    with SITcomm
  177.     getTimer()
  178.  
  179. Verb    SITcomm.getToolConfig
  180. Syntax    SITcomm.getToolConfig(class)
  181. Parameters    class  (e.g. classConnection, classTerminal, classTransfer)
  182. Returns    returns a text string from the current tool of the given class that represents its state.
  183. Example    with SITcomm
  184.     getToolConfig(classConnection)
  185. See Also    SITcomm.getToolConfigForAddress
  186.  
  187. Verb    SITcomm.getToolConfigForAddress
  188. Syntax    SITcomm.getToolConfigForAddress(class, addressName) 
  189. Parameters    class -- (e.g. classConnection, classTerminal, classTransfer)
  190. addressName -- An Address Book entry
  191. Returns    returns a text string from the tool of the given class for the specified address that represents its state.
  192. Example    SITcomm.getToolConfigForAddress(classConnection, "CIS") 
  193. See Also    SITcomm.getToolConfig
  194.  
  195. Verb    SITcomm.getToolList
  196. Syntax    SITcomm.getToolList(class)
  197. Parameters    class  (e.g. classConnection, classTerminal, classTransfer)
  198. Returns    returns a list of tools for the given class. 
  199. Example    with SITcomm
  200.     getToolList(classConnection)
  201. See Also    SITcomm.getToolConfigForAddress
  202. SITcomm.getToolConfig
  203. SITcomm.setToolConfig
  204. SITcomm.getToolName
  205. SITcomm.setToolName
  206.  
  207. Verb    SITcomm.getToolName
  208. Syntax    SITcomm.getToolName(class)
  209. Parameters    class  (e.g. classConnection, classTerminal, classTransfer)
  210. Returns    returns the name of the current tool for the given class. 
  211. Example    with SITcomm
  212.     getToolName(classConnection)
  213. See Also    SITcomm.getToolConfigForAddress
  214. SITcomm.getToolConfig
  215. SITcomm.setToolConfig
  216. SITcomm.setToolName
  217. SITcomm.getToolList
  218.  
  219. Verb    SITcomm.getToolNameForAddress
  220. Syntax    SITcomm.getToolNameForAddress(class, addressName) 
  221. Parameters    class --(e.g. classConnection, classTerminal, classTransfer)
  222. addressName -- An Address Book entry
  223. Returns    returns the name of the current tool of the given class for the specified address
  224. Example    with SITcomm
  225.     getToolConfigForAddress(classConnection, "CIS") 
  226. See Also    SITcomm.getToolConfig
  227. SITcomm.setToolConfig
  228. SITcomm.getToolName
  229.  
  230. Verb    SITcomm.getXferSettings
  231. Syntax    SITcomm.getXferSettings() 
  232. Parameters    none
  233. Action    returns the name of the current file transfer tool & it's settings
  234. Returns    returns the name of the current file transfer tool & it's settings (CR delimited)
  235. Example    with SITcomm
  236.     getXferSettings() 
  237. See Also    SITcomm.getConnSettings
  238. SITcomm.getTermSettings
  239. SITcomm.setXferSettings
  240.  
  241. Verb    SITcomm.isConnectionOpen
  242. Syntax    SITcomm.isConnectionOpen()
  243. Parameters    none
  244. Action    Returns true if the connection is currently open.
  245. Returns    true if the connection is currently open.
  246. Example    with SITcomm
  247.     isConnectionOpen()
  248. See also    SITcomm.getConnectionStatus
  249.  
  250. Verb    SITcomm.isRunning
  251. Syntax    SITcomm.isRunning()
  252. Parameters    none
  253. Action    Returns true if SITcomm is currently running
  254. Returns    true if SITcomm is running
  255. Example    with SITcomm
  256.     isRunning()
  257. See also    SITcomm.bringToFront
  258. SITcomm.launch
  259.  
  260. Verb    SITcomm.launch
  261. Syntax    SITcomm.launch()
  262. Parameters     none required
  263. Action    launches SITcomm™
  264. Example    with SITcomm
  265.     launch()
  266. See Also    SITcomm.bringToFront
  267. SITcomm.openDocument
  268. SITcomm.quitApplication
  269.  
  270. Verb    SITcomm.listenForConnection
  271. Syntax    SITcomm.listenForConnection()
  272. Parameters    none required
  273. Action    places the current connection tool in a waiting mode.
  274. Returns    0 if the connection was made
  275. Example    with SITcomm
  276.     listenForConnection()
  277. See Also    SITcomm.connect
  278. SITcomm.disconnect
  279. SITcomm.listenForConnectionWithTimeout
  280.  
  281. Verb    SITcomm.listenForConnectionWithTimeout
  282. Syntax    SITcomm.listenForConnectionWithTimeout(n)
  283. Parameters    n -- You may optionally specify one of three timeout values. 
  284. positive value for time to wait (in seconds)
  285. 0 for a single attempt
  286. -1 for no timeout
  287. Action    places the current connection tool in a waiting mode
  288. Returns    0 if the connection was made
  289. Example    with SITcomm
  290.     listenForConnectionWithTimeout(10)
  291. See Also    SITcomm.listenForConnection
  292.  
  293. Verb    SITcomm.loadAddress
  294. Syntax    SITcomm.loadAddress(s)
  295. Parameters    (s) is the AddressBook entry whose settings you wish to load
  296. Action    Makes the current session configuration the specified address
  297. Returns    0 if SITcomm is running, and the address is loaded
  298. -1 if the Address Book entry does not exist
  299. -4 if the connection is already open.
  300. Example    with SITcomm
  301.     loadAddress("CIS")
  302. See also    SITcomm.connect
  303. SITcomm.disconnect
  304. SITcomm.getConnectionStatus
  305. SITcomm.openConnection
  306.  
  307. Verb    SITcomm.openConnection
  308. Syntax    SITcomm.openConnection()
  309. Parameters    none
  310. Action    opens communication channel to external devices using the current connection tool and settings.
  311. Returns    true if successful
  312. Example    with SITcomm
  313.     openConnection()
  314. See also    SITcomm.connect
  315. SITcomm.disconnect
  316. SITcomm.getConnectionStatus
  317. SITcomm.getCurrentAddress
  318.  
  319. Verb    SITcomm.openDocument
  320. Syntax    SITcomm.openDocument(file)
  321. Parameters    file is the path to the document you wish to open
  322. Action    does nothing.  It is here for future expansion.
  323. Example    with SITcomm
  324.     openDocument("HD:a file")
  325. See Also    SITcomm.printDocument
  326.  
  327. Verb    SITcomm.outlineAddressBook
  328. Syntax    SITcomm.outlineAddressBook(adrOutline, includeDetails)
  329. Parameters    adrOutline -- address of a Frontier cell (e.g.  @ scratchpad.x)
  330. includeDetails-- 0 includes Address Names only, 1 includes all details, including Tool names & settings
  331. Action    creates a Frontier outline of the contents of SITcomm™ Address Book
  332. Example    with SITcomm
  333.     SITcomm.outlineAddressBook(@scratchpad.hotNumbers, 0)
  334. Notes    if the current AddressBook is empty this verb returns 
  335. the error: "<<The Address Book is Empty!>>"
  336. See Also    SITcomm.getAddressList
  337.  
  338. Verb    SITcomm.pauseConnection
  339. Syntax    SITcomm.pauseConnection ()
  340. Parameters    none
  341. Action    Sends an XOFF character to the remote system.
  342. Returns    0 if no error
  343. Example    with SITcomm
  344.     pauseConnection ()
  345. See Also    SITcomm.resumeConnection
  346.  
  347. Verb    SITcomm.printDocument
  348. Syntax    SITcomm.printDocument(file)
  349. Parameters    file is the path to the document you wish to print
  350. Action    does nothing.  It is here for future expansion.
  351. Example    SITcomm.printDocument("HD:file")
  352. See Also    SITcomm.openDocument
  353.  
  354. Verb    SITcomm.printSelection
  355. Syntax    SITcomm.printSelection()
  356. Parameters    none
  357. Action    Prints the current text selection with the current printer setup.
  358. Example    with SITcomm
  359.     printSelection ()
  360. See Also    SITcomm.appendSelection
  361. SITcomm.getSelection
  362. SITcomm.saveSelection
  363.  
  364. Verb    SITcomm.quitApplication
  365. Syntax    SITcomm.quitApplication()
  366. Parameters    none required
  367. Action    quits SITcomm™
  368. Example    with SITcomm
  369.     quitApplication()
  370. See Also    SITcomm.isRunning
  371. SITcomm.launch
  372.  
  373. Verb    SITcomm.receiveFiles
  374. Syntax    SITcomm.receiveFiles()
  375. Parameters    none
  376. Action    Enters receive mode using the current transfer tool and settings.
  377. Returns    The list of files just recieved.
  378. Example    with SITcomm
  379.     receiveFiles()
  380. See Also    SITcomm.receiveFilesToFolder
  381. SITcomm.sendFiles
  382. SITcomm.setReceiveFolder
  383.  
  384. Verb    SITcomm.receiveFilesToFolder
  385. Syntax    SITcomm.receiveFilesToFolder(f)
  386. Parameters    (f) is the pathname to folder to recieve files to.
  387. Action    Enters receive mode using the current transfer tool and settings..
  388. Returns    The list of files just recieved.
  389. Examples    with SITcomm
  390.     » receiveFilesToFolder(file.folderFromPath(SITcomm.appInfo.Path))
  391. See Also    SITcomm.receiveFiles
  392. SITcomm.sendFiles
  393. SITcomm.setReceiveFolder
  394.  
  395. Verb    SITcomm.resumeConnection
  396. Syntax    SITcomm.resumeConnection ()
  397. Parameters    none
  398. Action    Sends an XON character to the remote system.
  399. Returns    0 if no error
  400. Example    with SITcomm
  401.     resumeConnection ()
  402. See Also    SITcomm.pauseConnection
  403.  
  404. Verb    SITcomm.saveSelection
  405. Syntax    SITcomm.saveSelection(f)
  406. Parameters    (f) is the path to destination file
  407. Action    Saves current text selection into the specified file.
  408. Example    with SITcomm
  409.     saveSelection ("HD:SITcomm™:Notes")
  410. See Also    SITcomm.appendSelection
  411. SITcomm.getSelection
  412. SITcomm.printSelection
  413.  
  414. Verb    SITcomm.sendBreak
  415. Syntax    SITcomm.sendBreak()
  416. Parameters    none
  417. Action    sends a short break
  418. Example    with SITcomm
  419.     sendBreak ()
  420. See Also    SITcomm.sendLongBreak
  421.  
  422. Verb    SITcomm.sendFiles
  423. Syntax    SITcomm.sendFiles(f)
  424. Parameters    f is the path to the file you wish to send
  425. Action    Send the specified files to the remote system using the current transfer tool and settings.
  426. Example    SITcomm.sendFiles ("HD:Daily Report")
  427. See Also    SITcomm.receiveFiles
  428. SITcomm.receiveFilesToFolder
  429. SITcomm.sendTextFile
  430.  
  431. Verb    SITcomm.sendLongBreak
  432. Syntax    SITcomm.sendLongBreak()
  433. Parameters    none
  434. Action    sends a long break
  435. Example    with SITcomm
  436.     sendLongBreak ()
  437. See Also    SITcomm.sendBreak
  438.  
  439. Verb    SITcomm.sendText
  440. Syntax    SITcomm.sendText(s)
  441. Parameters    (s) is the string you wish to send
  442. Action    Send the given text to the remote system.
  443. Example    SITcomm.sendText(s)
  444. See Also    SITcomm.sendFiles
  445. SITcomm.sendTextFile
  446. SITcomm.waitForText
  447.  
  448. Verb    SITcomm.sendTextFile
  449. Syntax    SITcomm.sendTextFile(f, width)
  450. Parameters    f is the path to the file you wish to send
  451. width is the character width you want to wrap the outgoing text to (0 = no wrap)
  452. Action    Sends the contents of the specified file to the host with optional text wrapping
  453. Example    SITcomm.sendTextFile ("Development:Trade Secrets", 75)
  454. Notes    This verb is implemented as a script in the SITcomm/Frontier glue table.
  455. To take a closer look command-2click on the name of the verb within Frontier.
  456. See Also    SITcomm.sendFiles
  457. SITcomm.sendTextWithDelay
  458.  
  459. Verb    SITcomm.sendTextWithDelay
  460. Syntax    SITcomm.sendTextWithDelay(s, delay)
  461. Parameters    s is the string of Text you wish to send
  462. delay is the amount of time in Seconds you wish to delay
  463. Action    Sends the given text to the remote system, with the specified intercharacter delay.
  464. Example    SITcomm.sendTextWithDelay ("Hi Mom!",1)
  465. See Also    SITcomm.sendFiles
  466. SITcomm.sendText
  467. SITcomm.sendTextFile
  468.  
  469. Verb    SITcomm.setConnSettings
  470. Syntax    SITcomm.setConnSettings (setng)
  471. Parameters     (setng) is the setting you wish to set
  472. Action    sets the current connection tool's settings
  473. Example    with SITcomm
  474.     setConnSettings("Baud 2400")
  475. Notes    The string you pass is based on the scripting interface of the tool as defined by the CTB, consisting of token/value pairs.
  476. To see what is there, use the getConnSettings or outlineAddressBook commands to view the current settings.
  477. See Also    SITcomm.getConnSettings
  478. SITcomm.getToolConfig
  479. SITcomm.getToolConfigForAddress
  480. SITcomm.setToolConfig
  481.  
  482. Verb    SITcomm.setGlobalNotepadText
  483. Syntax    SITcomm.setGlobalNotepadText(s)
  484. Parameters    s is a string of text.
  485. Action    Sets the global notepad's text to the given text.
  486. Example    with SITcomm
  487.     setGlobalNotepadText("The West Wind Shapes The Pine…")
  488. See Also    SITcomm.getGlobalNotepadText
  489. SITcomm.getNotepadText
  490. SITcomm.setNotepadText
  491.  
  492. Verb    SITcomm.setNotepadText
  493. Syntax    SITcomm.setNotepadText(s)
  494. Parameters    s is a string of text.
  495. Action    Sets the current notepad's text to the given text.
  496. Returns    0 if there is no error
  497. -1 if there is no current session
  498. Example    with SITcomm
  499.     setNotepadText("Can't count to 1…without thinking twice")
  500. See Also    SITcomm.getNotepadText
  501. SITcomm.setGlobalNotepadText
  502. SITcomm.getGlobalNotepadText
  503.  
  504. Verb    SITcomm.setReceiveFolder
  505. Syntax    SITcomm.setReceiveFolder(f)
  506. Parameters    f -- path to destination folder
  507. Action    Sets the file receive folder to the given directory
  508. Returns    0 if successful
  509. Example    with SITcomm
  510.     setReceiveFolder("HD: Mail:")
  511. See Also    SITcomm.getReceiveFolder
  512.  
  513. Verb    SITcomm.setTermSettings
  514. Syntax    SITcomm.setTermSettings(setng)
  515. Parameters     (setng) are the settings you wish to set
  516. Action    sets the current terminal tool's settings
  517. Example    with SITcomm
  518.     setTermSettings("LocalEcho True")
  519. Notes    The string you pass is based on the scripting interface of the tool as defined by the CTB, consisting of token/value pairs.
  520. To see what is there, use the getTermSettings or outlineAddressBook commands to view the current settings.
  521. See Also    SITcomm.getTermSettings
  522. SITcomm.getToolConfig
  523. SITcomm.getToolConfigForAddress
  524. SITcomm.setToolConfig
  525.  
  526. Verb    SITcomm.setToolConfig
  527. Syntax    SITcomm.getToolConfig(class, configstring) 
  528. Parameters    class --  (e.g. classConnection, classTerminal, classTransfer)
  529. configstring --string of Configuration Settings you wish to set
  530. Example    with SITcomm
  531.     setToolConfig(classTerminal,"LocalEcho True")
  532. Notes    The string you pass is based on the scripting interface of the tool as defined by the CTB, consisting of token/value pairs.
  533. To see what is there, use the getConnSettings or outlineAddressBook commands to view the current settings.
  534. See Also    SITcomm.getToolConfig
  535. SITcomm.getToolConfigForAddress
  536. SITcomm.setConnSettings
  537. SITcomm.setTermSettings
  538. SITcomm.setXferSettings
  539.  
  540. Verb    SITcomm.setToolName
  541. Syntax    SITcomm.setToolName(class, toolname)
  542. Parameters    class -- (e.g. classConnection, classTerminal, classTransfer)
  543. toolName -- the name of the tool to use
  544. Action    Changes the current tool of the given class to the one specified by name.
  545. Example    with SITcomm
  546.     setToolName(classTransfer,"Aladdin ZMODEM Tool")
  547. Notes    The string you pass is based on the scripting interface of the tool as defined by the CTB, consisting of token/value pairs.
  548. To see what is there, use the.getConnSettings or outlineAddressBook commands to view the current settings.
  549. See Also    SITcomm.getToolConfig
  550. SITcomm.getToolConfigForAddress
  551. SITcomm.getToolList
  552. SITcomm.getToolName
  553. SITcomm.setToolConfig
  554.  
  555. Verb    SITcomm.setXferSettings
  556. Syntax    SITcomm.setXferSettings(setng) 
  557. Parameters    (setng) are the settings you wish to set
  558. Action    configures the current file transfer tool's settings.
  559. Example    with SITcomm
  560.     setXferSettings("AutoRecieve True") 
  561. Notes    The string you pass is based on the scripting interface of the tool as defined by the CTB, consisting of token/value pairs.
  562. To see what is there, use the getXferSettings or outlineAddressBook commands to view the current settings.
  563. See Also    SITcomm.getXferSettings
  564. SITcomm.getToolConfig
  565. SITcomm.getToolConfigForAddress
  566. SITcomm.setToolConfig
  567.  
  568. Verb    SITcomm.stuff
  569. Syntax    SITcomm.stuff(file, destination, deleteoriginal, makesea, encrypt, nocompress) 
  570. Parameters    file -- the file you wish to stuff 
  571. destination -- Use this parameter to specify path string to a file for the resulting archive. Default is to name as “Archive.sit”.
  572. deleteoriginal -- true or false
  573. makesea -- passing true makes a self-unstuffing archive
  574. encrypt -- passing true makes the archive encrypted
  575. nocompress -- passing true creates an uncompressed archive
  576. Action    stuffs a list of files into an archive.
  577. Returns    0 if there is no error.
  578. 4 if there is an archive integrity error,
  579. a negative number indicates a standard Macintosh OSError
  580. Example    with SITcomm
  581.     stuff ("HD: Example", "System:U/Ls:Example.sit", true, false, false, false)
  582. See also    SITcomm.stuffInPlace
  583. SITcomm.stuffInPlaceAsSEA
  584. SITcomm.stuffInPlaceWithEncryption
  585. SITcomm.expand
  586. SITcomm.translate
  587.  
  588. Verb    SITcomm.stuffInPlace
  589. Syntax    SITcomm.stuffInPlace(file, deleteoriginal) 
  590. Parameters    file -- the file you wish to stuff 
  591. deleteoriginal -- true or false
  592. Action    stuffs a list of files into an archive.
  593. Returns    0 if there is no error.
  594. 4 if there is an archive integrity error,
  595. a negative number indicates a standard Macintosh OSError
  596. Example    with SITcomm
  597.     stuffInPlace("HD: Example", true)
  598. See also    SITcomm.stuff
  599. SITcomm.stuffInPlaceAsSEA
  600. SITcomm.stuffInPlaceWithEncryption
  601. SITcomm.expand
  602. SITcomm.translate
  603.  
  604. Verb    SITcomm.stuffInPlaceAsSEA
  605. Syntax    SITcomm.stuffInPlaceAsSEA(file, deleteoriginal) 
  606. Parameters    file -- the file you wish to stuff 
  607. deleteoriginal -- true or false
  608. Action    stuffs a list of files into a self-extracting archive.
  609. Returns    0 if there is no error.
  610. 4 if there is an archive integrity error,
  611. a negative number indicates a standard Macintosh OSError
  612. Example    with SITcomm
  613.     stuffInPlaceAsSEA("HD: Example", true)
  614. See also    SITcomm.stuff
  615. SITcomm.stuffInPlace
  616. SITcomm.stuffInPlaceWithEncryption
  617. SITcomm.expand
  618. SITcomm.translate
  619.  
  620. Verb    SITcomm.stuffInPlaceWithEncryption
  621. Syntax    SITcomm.stuffInPlaceWithEncryption(file, deleteoriginal) 
  622. Parameters    file -- the file you wish to stuff 
  623. deleteoriginal -- true or false
  624. Action    stuffs a list of files into an encrypted archive.
  625. Returns    0 if there is no error.
  626. 4 if there is an archive integrity error,
  627. a negative number indicates a standard Macintosh OSError
  628. Example    with SITcomm
  629.     stuffInPlaceWithEncryption("HD: Example", true)
  630. See also    SITcomm.stuff
  631. SITcomm.stuffInPlace
  632. SITcomm.stuffInPlaceAsSEA
  633. SITcomm.expand
  634. SITcomm.translate
  635.  
  636. Verb    SITcomm.translate
  637. Syntax    SITcomm.translate(file, translationformat, tomacformat, destination)
  638. Parameters    file -- the file you wish to translate. 
  639. translationFormat -- Name of translation format (eg. "ZIP").
  640. toMacFormat -- true if translating to Mac (decoding), false if to Foreign format (encoding).
  641. destination -- Use this parameter to specify path string to a file or it will default to the same location as the source file.
  642. Action    translates a file.
  643. Example    with SITcomm
  644.     translate ("HD:Example.zip", "ZIP", true, "HD:Translated Files:")
  645. See also    SITcomm.expand
  646. SITcomm.translateDecode
  647. SITcomm.translateEncode
  648.  
  649. Verb    SITcomm.translateDecode
  650. Syntax    SITcomm.translateDecode(file, translationformat)
  651. Parameters    file -- the file you wish to translate. 
  652. translationFormat -- Name of translation format (eg. "ZIP").
  653. Action    Decodes a foreign file format into Macintosh files
  654. Example    with SITcomm
  655.     translate ("HD:Example.zip", "ZIP")
  656. See also    SITcomm.expand
  657. SITcomm.translate
  658. SITcomm.translateEncode
  659.  
  660. Verb    SITcomm.translateEncode
  661. Syntax    SITcomm.translateEncode(file, translationformat)
  662. Parameters    file -- the file you wish to translate. 
  663. translationFormat -- Name of translation format (eg. "ZIP").
  664. Action    Encodes a Macintosh file into another format.
  665. Example    with SITcomm
  666.     translate ("HD:Report.sit", "BinHex4")
  667. See also    SITcomm.expand
  668. SITcomm.translate
  669. SITcomm.translateDecode
  670.  
  671. Verb    SITcomm.turnOffCapturing
  672. Syntax    SITcomm.turnOffCapturing()
  673. Parameters     none required
  674. Action    Closes the currently active capture file.
  675. Example    with SITcomm
  676.     turnOffCapturing()
  677. See Also    SITcomm.turnOnCapturing
  678. SITcomm.turnOnCapturingWithFile
  679.  
  680. Verb    SITcomm.turnOffPrinting
  681. Syntax    SITcomm.turnOffPrinting()
  682. Parameters     none required
  683. Action    Closes the current print job.
  684. Example    with SITcomm
  685.     turnOffPrinting()
  686. See Also    SITcomm.turnOnPrinting
  687.  
  688. Verb    SITcomm.turnOnCapturing
  689. Syntax    SITcomm.turnOnCapturing()
  690. Parameters     none required
  691. Action    Opens a file to capture incoming and outgoing text data.
  692. Example    with SITcomm
  693.     turnOnCapturing()
  694. See Also    SITcomm.turnOffCapturing
  695. SITcomm.turnOnCapturingWithFile
  696.  
  697. Verb    SITcomm.turnOnCapturingWithFile
  698. Syntax    SITcomm.turnOnCapturingWithFile(f)
  699. Parameters     f is the full pathname to a file to capture incoming and outgoing text data
  700. Action    Opens specified file to capture incoming and outgoing text data
  701. Example    with SITcomm
  702.     turnOnCapturingWithFile ()
  703. See Also    SITcomm.turnOffCapturing
  704. SITcomm.turnOnCapturing
  705.  
  706. Verb    SITcomm.turnOnPrinting
  707. Syntax    SITcomm.turnOnPrinting()
  708. Parameters     none required
  709. Action    Opens the current printer to print incoming and outgoing text data.
  710. Example    with SITcomm
  711.     turnOnPrinting()
  712. See Also    SITcomm.turnOffPrinting
  713.  
  714. Verb    SITcomm.waitForText
  715. Syntax    SITcomm.waitForText(s)
  716. Parameters    s is the string of Text to search for.
  717. Action    Placse a search on the connection for the specified text string.
  718. Returns    The text that was found, or empty string if the search timed out
  719. Example    with SITcomm
  720.     waitForText("Please Enter Your Name:")
  721. Notes    WaitForText will look on the terminal screen to the left of the cursor for the text that you specify (s).
  722. The advantage of the standard WFT, is that it is case insensitive and doesn't rely on timing.
  723. See Also    SITcomm.waitForTextInStream
  724. SITcomm.waitForTextList
  725. SITcomm.waitForTextWithTimeout
  726.  
  727. Verb    SITcomm.waitForTextInStream
  728. Syntax    SITcomm.waitForTextInStream(s)
  729. Parameters    s is the string of Text to search for.
  730. Action    Place a search on the raw connection data for the specified text string
  731. Returns    The text that was found, or empty string if the search timed out
  732. Example    with SITcomm
  733.     waitForText("Password:")
  734. Notes    Use waitForTextInStream when you want to search for non-display characters like control characters.
  735. See Also    SITcomm.waitForText
  736. SITcomm.waitForTextList
  737. SITcomm.waitForTextWithTimeout
  738.  
  739. Verb    SITcomm.waitForTextList
  740. Syntax    SITcomm.waitForTextList(s1, s2, s3)
  741. Parameters    s1, s2, s3 - these are up the three strings to search for
  742. Action    Place a search on the connection for the specified text strings
  743. Returns    The text that was found, or empty string if the search timed out
  744. Example    with SITcomm
  745.     waitForTextList("You Have Mail", "You Have No Mail", "")
  746. Notes    This command is equivalent to WaitForText, but allows you to specify multiple strings.
  747. Although the command is not limited to three strings, Frontier 2.0 does not allow for passing lists easily.
  748. See Also    SITcomm.waitForText
  749. SITcomm.waitForTextInStream
  750. SITcomm.waitForTextWithTimeout
  751.  
  752. Verb    SITcomm.waitForTextWithTimeout
  753. Syntax    SITcomm.waitForTextWithTimeout(s, timeout)
  754. Parameters    s is the string of Text to search for.
  755. timeout is the number of seconds to wait.
  756. Action    place a search on the connection for the specified text string.
  757. Returns    The text that was found, or empty string if the search timed out
  758. Example    with SITcomm
  759.     waitForTextWithTimeout("Press Any Key To Continue:",3)
  760. See Also    SITcomm.waitForText
  761. SITcomm.waitForTextInStream
  762. SITcomm.waitForTextList
  763.